major: Add support for `tag-directory-separator` and `use-version-prefix` inputs, with workflow, config, and mock/test improvements #227

virgofx · 2025-06-16T17:00:56Z

This pull request introduces a set of improvements and updates across CI workflows, documentation, and development tooling. The main changes include enhanced configuration options for the Terraform module releaser, updates to workflow actions and dependencies, and refinements to documentation for clarity and completeness.

Documentation and Configuration Improvements

Added new input parameters to the Terraform module releaser, including wiki-usage-template, tag-directory-separator, and use-version-prefix, and clarified descriptions for existing parameters in README.md. Also improved documentation of output variables for modules. [1] [2] [3]
Updated example configuration and descriptions for usage templates, filtering options, and output formats in README.md for better guidance and accuracy. [1] [2] [3] [4]

CI Workflow Updates

Upgraded terraform-docs-version to v0.20.0 and expanded module-path-ignore patterns in .github/workflows/ci.yml. Added support for tag-directory-separator and use-version-prefix options.
Updated the Super-Linter action to v8.0.0 for improved linting in .github/workflows/lint.yml.
Changed the SonarQube scan action to a specific commit SHA for reproducibility in .github/workflows/test.yml. Also standardized the test job name and permissions. [1] [2]
Updated the changelog script import path and pinned the create-pull-request action to a specific commit in .github/workflows/release-start.yml. [1] [2]

Development Environment and Tooling

Switched the Prettier devcontainer feature to a community-maintained version and removed SSH agent forwarding from .devcontainer/devcontainer.json for improved compatibility. [1] [2]

Test Mock Refinements

Updated mock implementations in __mocks__/@actions/core.ts to use unused parameter names for clarity and consistency in testing. [1] [2] [3] [4]

- Add ACTION_INPUTS mapping for all GitHub Action inputs - Add createConfigFromInputs() function for dynamic config creation - Implement proper array parsing that distinguishes required vs optional - Required array inputs throw error on empty string - Optional array inputs return empty array on empty string - Add comprehensive type definitions for action metadata

- Replace manual input processing with createConfigFromInputs() - Add comprehensive validation for tag directory separator - Add validation for default first tag format - Simplify config initialization using metadata-driven approach - Update config mock to use real action metadata system - Improve error messages with more specific validation details

- Refactor input helpers to use centralized ACTION_INPUTS metadata - Add getActionDefaults() to load defaults from action.yml - Generate input type arrays dynamically from metadata - Add getConfigKey() helper for type-safe config access - Simplify setupTestInputs() to use action.yml defaults - Remove hardcoded input arrays in favor of metadata-driven approach

- Add tests for tag directory separator validation (length and character) - Add tests for default first tag format validation - Add tests for required vs optional array input handling - Add tests for array parsing edge cases and deduplication - Improve test organization with metadata-driven approach - Achieve 100% test coverage for config.ts validation logic

- Set up required GitHub environment variables in context tests - Fix test isolation by properly clearing context between tests - Ensure environment variables are set before context initialization - Resolve test failures caused by missing GitHub Action environment

Fixes: https://app.aikido.dev/repositories/462873?sidebarIssue=3135661

https://app.aikido.dev/repositories/462873?sidebarIssue=3135661

…ility

- Removed deprecated action-metadata types and utility functions. - Introduced new metadata structure for action inputs in `metadata.ts`. - Updated configuration handling to support dynamic input mapping. - Enhanced tag processing to accommodate various directory separators. - Added tests for metadata input handling and error scenarios. - Improved regex patterns for module tag validation. - Updated action.yml to include new input parameters for tag directory separator and version prefix usage. - Refactored TerraformModule class to utilize new configuration settings for versioning.

… and examples for directory separator and version prefix options

…e template handling

refactor: remove redundant release content structure validation from tests chore: update biome configuration to include all scripts chore: add new changelog script and remove deprecated action.yml test: add parse-modules-test script for local testing of parseTerraformModules function feat: implement changelog generation with GitHub API integration delete: remove unused development script for parsing modules

github-actions · 2025-08-21T06:46:06Z

📋 Release Plan

Module	Type	Latest Version	New Version	Release Details
`tf-modules-kms`	patch		1.0.0	🆕 Initial Release
`tf-modules-vpc-endpoint`	patch		1.0.0	🆕 Initial Release

📝 Changelog

`tf-modules-kms-1.0.0` (2025-08-21)

🔀PR #227 - major: Add support for tag-directory-separator and use-version-prefix inputs, with workflow, config, and mock/test improvements

`tf-modules-vpc-endpoint-1.0.0` (2025-08-21)

🔀PR #227 - major: Add support for tag-directory-separator and use-version-prefix inputs, with workflow, config, and mock/test improvements

_{Wiki Status^ℹ️}

✅ Enabled

_{Automated Tag/Release Cleanup^ℹ️}

⏸️ Existing tags and releases will be preserved as the delete-legacy-tags flag is disabled.

_{Powered by: techpivot/terraform-module-releaser}

Copilot

Pull Request Overview

This pull request introduces comprehensive support for configurable tag directory separators and version prefixes in Terraform module releases, alongside significant refactoring of configuration management and testing infrastructure.

Adds tag-directory-separator and use-version-prefix inputs for flexible tagging schemes
Refactors configuration management with centralized metadata-driven approach
Consolidates template rendering functionality and improves string utilities

Reviewed Changes

Copilot reviewed 43 out of 44 changed files in this pull request and generated no comments.

Show a summary per file

File	Description
src/wiki.ts	Updates module source URL formatting and switches to new template rendering function
src/utils/string.ts	Removes trimSlashes function and adds renderTemplate and removeLeadingCharacters utilities
src/utils/metadata.ts	New centralized configuration metadata system for action inputs
src/utils/constants.ts	Adds tag directory separator validation and improved regex patterns
src/types/metadata.types.ts	New type definitions for action input metadata
src/types/index.ts	Exports new metadata types
src/types/context.types.ts	Updates import paths to use absolute imports
src/types/config.types.ts	Adds new configuration options with detailed documentation
src/terraform-module.ts	Major refactoring for flexible tag directory separators and version prefixes
src/templating.ts	Removed - functionality moved to utils/string.ts
src/context.ts	Updates unused parameter naming for consistency
src/config.ts	Refactors to use metadata-driven configuration system
Various test files	Updates tests to support new configuration system and improve coverage
action.yml	Adds new input parameters and reorders for better organization
README.md	Documents new configuration options and improves examples
CI/Workflow files	Updates versions and configurations

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

sonarqubecloud · 2025-08-21T06:46:40Z

Quality Gate passed

Issues
1 New issue
0 Accepted issues

Measures
0 Security Hotspots
100.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

virgofx marked this pull request as draft June 16, 2025 17:01

virgofx force-pushed the 183-semver-pattern-without-v-prefix branch 5 times, most recently from 2d7550c to a43d686 Compare June 25, 2025 21:07

virgofx mentioned this pull request Jul 11, 2025

Update tag format dist #231

Closed

virgofx force-pushed the 183-semver-pattern-without-v-prefix branch 3 times, most recently from f52c0a6 to eb44238 Compare August 19, 2025 00:36

techpivot deleted a comment from github-actions bot Aug 19, 2025

virgofx force-pushed the 183-semver-pattern-without-v-prefix branch from 832fdd3 to 9ab9723 Compare August 19, 2025 01:17

virgofx added 18 commits August 19, 2025 01:20

fix: correct import paths and type inconsistencies

955a183

chore: update dependencies and action.yml defaults

f3202d8

chore: update package dependencies to latest versions

1b72627

fix: remove unnecessary SSH agent forwarding and update prettier feature

341fecc

fix: update super-linter action to specific version for consistency

3b26ad4

Fixes: https://app.aikido.dev/repositories/462873?sidebarIssue=3135661

fix: update create-pull-request action to specific version for stability

2a490b2

https://app.aikido.dev/repositories/462873?sidebarIssue=3135661

fix: update SonarQube scan action to specific commit SHA for stability

b80ea3f

fix: update package dependencies to latest versions for improved stab…

0c654e2

…ility

fix: update rollup packages to version 4.44.0 for improved compatibility

6dff8a5

feat: enhance tag generation configuration with detailed descriptions…

26b7e79

… and examples for directory separator and version prefix options

fix: remove eslint directive for throwing literals in metadata tests

99ee82a

chore: update dependencies

f3e2d30

virgofx force-pushed the 183-semver-pattern-without-v-prefix branch from 7b01d87 to b60d18e Compare August 21, 2025 04:50

feat: refactor render -> renderTemplate function and update wiki usag…

b33ab14

…e template handling

virgofx force-pushed the 183-semver-pattern-without-v-prefix branch 2 times, most recently from 13aba7b to 18a8745 Compare August 21, 2025 05:45

virgofx self-assigned this Aug 21, 2025

virgofx added enhancement New feature or request dependencies Pull requests that update a dependency file documentation Improvements or additions to documentation labels Aug 21, 2025

virgofx force-pushed the 183-semver-pattern-without-v-prefix branch 4 times, most recently from 873f4ba to 30e90a3 Compare August 21, 2025 06:05

virgofx marked this pull request as ready for review August 21, 2025 06:07

virgofx force-pushed the 183-semver-pattern-without-v-prefix branch from 30e90a3 to cc5eec2 Compare August 21, 2025 06:09

virgofx requested review from Copilot and removed request for Copilot August 21, 2025 06:09

This comment was marked as outdated.

Sign in to view

virgofx requested a review from Copilot August 21, 2025 06:27

This comment was marked as outdated.

Sign in to view

fix: update documentation links and remove test comment in main.tf

f94d31c

virgofx force-pushed the 183-semver-pattern-without-v-prefix branch from 4aa960c to f94d31c Compare August 21, 2025 06:45

virgofx requested a review from Copilot August 21, 2025 06:45

Copilot AI reviewed Aug 21, 2025

View reviewed changes

virgofx merged commit 664bdbc into main Aug 21, 2025
24 checks passed

virgofx deleted the 183-semver-pattern-without-v-prefix branch August 21, 2025 06:48

release-preview bot mentioned this pull request Aug 21, 2025

chore(release): v1.7.0 #247

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

major: Add support for `tag-directory-separator` and `use-version-prefix` inputs, with workflow, config, and mock/test improvements #227

major: Add support for `tag-directory-separator` and `use-version-prefix` inputs, with workflow, config, and mock/test improvements #227

virgofx commented Jun 16, 2025 •

edited

Loading

Uh oh!

This comment was marked as outdated.

Uh oh!

This comment was marked as outdated.

Uh oh!

github-actions bot commented Aug 21, 2025

Uh oh!

Copilot AI left a comment

Uh oh!

sonarqubecloud bot commented Aug 21, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

major: Add support for tag-directory-separator and use-version-prefix inputs, with workflow, config, and mock/test improvements #227

major: Add support for tag-directory-separator and use-version-prefix inputs, with workflow, config, and mock/test improvements #227

Conversation

virgofx commented Jun 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Documentation and Configuration Improvements

CI Workflow Updates

Development Environment and Tooling

Test Mock Refinements

Uh oh!

This comment was marked as outdated.

Uh oh!

This comment was marked as outdated.

Uh oh!

github-actions bot commented Aug 21, 2025

📋 Release Plan

📝 Changelog

tf-modules-kms-1.0.0 (2025-08-21)

tf-modules-vpc-endpoint-1.0.0 (2025-08-21)

Wiki Statusℹ️

Automated Tag/Release Cleanupℹ️

Powered by: techpivot/terraform-module-releaser

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

sonarqubecloud bot commented Aug 21, 2025

Quality Gate passed

Uh oh!

Uh oh!

Uh oh!

major: Add support for `tag-directory-separator` and `use-version-prefix` inputs, with workflow, config, and mock/test improvements #227

major: Add support for `tag-directory-separator` and `use-version-prefix` inputs, with workflow, config, and mock/test improvements #227

virgofx commented Jun 16, 2025 •

edited

Loading

`tf-modules-kms-1.0.0` (2025-08-21)

`tf-modules-vpc-endpoint-1.0.0` (2025-08-21)

_{Wiki Status^ℹ️}

_{Automated Tag/Release Cleanup^ℹ️}

_{Powered by: techpivot/terraform-module-releaser}